Xbasic

SQL::SchemaListTablesWithTypes Method

Syntax

Table_List as C = ListTablesWithTypes(P Filter)

Table_List as C = .ListTablesWithTypes( [ IncludeTables as L [, IncludeViews as L [, IncludeSystemTables as L [, IncludeSynonyms as L [, IncludeAliases as L ]]]]] )

Arguments

Table_List: The retrieved list of tables.
SQL::Schema: A SQL::Schema object.
IncludeTables: Optional. Default = .T. (TRUE) = Include tables
IncludeViews: Optional. Default = .T. (TRUE) = Include views
IncludeSystemTables: Optional. Default = .T. (TRUE) = Include system tables
IncludeSynonyms: Optional. Default = .T. (TRUE) = Include synonyms
IncludeAliases: Optional. Default = .T. (TRUE) = Include aliases
Filter: Pointer

Description

Return a list of tables for the current database suffixed with (<type>).

Discussion

The ListTablesWithTypes() method returns a list of tables in the cache for the current database suffixed with type. For example a table named Categories is returned as Categories (Table) where a view called Category Summary is returned as Category Summary (View).

Example

dim conn as SQL::Connection
dim sch as SQL::Schema
connString = "{A5API='Access', FileName='c:\program files\a5v8\mdbfiles\alphasports.mdb'}"
if .not. conn.open(connString)
   ui_msg_box("Error", conn.CallResult.text)
   end
end if
if .not. conn.GetSchema(sch) then
   ui_msg_box("Error", conn.CallResult.text)
   conn.close()
   end
end if
ui_msg_box("Tables", sch.ListTablesWithTypes())
conn.close()